home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / macros / latex209 / contrib / chbars / README < prev    next >
Text File  |  1993-01-11  |  5KB  |  128 lines
  1. % README for changebar macros            28 Jul 92
  2. %------------------------------------------------------------
  3.  
  4.  
  5. GENERAL NOTES by Joachim Schrod. (Minor revisions by R. Bernstein)
  6.  
  7. These are my (Joachim Schrod's) macros for producing change bars with
  8. TeX or LaTeX.  Please note that (1) these macros will not produce an
  9. optimal page breaking (i.e. vertical glue will disappear in many
  10. places) and (2) that there is still a problem with these macros: it is
  11. described in the last section of the chapter `Handling the Page
  12. Contents.' By the way, this problem is within the current LaTeX, too.
  13.  
  14. The macros were written for TeX 2. In the meantime TeX 3 became
  15. available; new features (i.e., \holdinginsert) would now allow a
  16. better implementation.
  17.  
  18. The macros are written for the usage with Plain TeX. R. Bernstein did
  19. the the LaTeX adaption because I neither use LaTeX in my own documents
  20. nor do I need change bars... For me, it was just a nice play to show
  21. what can be done with the \output routine of TeX. Therefore I will not
  22. put further work in these macros. But I will happily redistribute
  23. enhancements and will make them available on the usual TeX servers.
  24.  
  25. So: If you enhance the macros, make further adaptations of them for
  26. LaTeX, or if you incorporate the new features of TeX 3, send them to
  27. me so that others can share your work.
  28.  
  29.  
  30. NOTES ON THE DISTRIBUTED FILES
  31.  
  32. The macro file chbars.doc can be LaTeXed (the result is not as
  33. readable as it should be---but this is due to the inflexibility of the
  34. \@startsection macro of LaTeX).  The needed style files are included.
  35.  
  36. Furthermore four test files for the usage of change bars in vertical
  37. and horizontal mode are included, too. The files test1.tex, test2.tex
  38. and test3.tex should be run through Plain TeX; test4.ltx should be run
  39. through LaTeX. Files test3.tex and test4.tex try out features that
  40. have been added to these macros since they were originally written. In
  41. particular, setting the change bar width, placement on the right or
  42. left margin, redefining the \output routine, and a LaTeX test.
  43.  
  44. These macros are documented with my MAKEPROG processor.  Perhaps I
  45. should mention why I don't use the doc-option of Frank Mittelbach:
  46. MAKEPROG has been written by me before I have heard of the existence
  47. of doc. But even then I would have written it: doc is a special
  48. documentation tool for TeX macros which heavily depends on LaTeX and
  49. the LaTeX coding conventions.  It is not very easy to use it for the
  50. documentation of other stuff than LaTeX macros.  In contrary, MAKEPROG
  51. is a {\it general documentation facility\/} which I use for all things
  52. where WEB is not available.  (In fact, it was created to document lex
  53. and yacc programs...) Especially the changefile possibility I need
  54. very hardly.  MAKEPROG has the disadvantage that a special care of the
  55. TeX environment (e.g. the indexing of macro names) can not be
  56. implemented. I'm still working on MAKEPROG, the next version 2.0 will
  57. have a code rearrangement ability like TANGLE. 
  58.  
  59. MAKEPROG may be fetched from LISTSERV@DHDURZ1 (for the Bitnet folks)
  60. and per ftp from Washington (where it is in the UNIX distribution).  I
  61. would prefer if you get it from there so that I don't have to mail out
  62. so much stuff.  If you have no access contact me.  If you are working
  63. on an IBM(-compatible) PC you should nevertheless contact me: I have
  64. changefiles for Turbo Pascal available. 
  65.  
  66. I'm not really satisfied that I have not found the time to update the
  67. documentation of MAKEPROG to mention that progltx, the
  68. progdoc-equivalent LaTeX style option, exists.  To get a
  69. documentation you must run LaTeX over progltx.doc and print the
  70. result.  Because I print the whole stuff usually on A4 paper I have
  71. included a style option for A4 page layout, too.  The macro file
  72. a4-9.sty assumes that the driver leaves a margin of 1 in.  Please
  73. note, that this is not just ``one other'' A4 page layout -- it was
  74. designed by a typographer and I have only done the LaTeX
  75. realization---have a look at a4-9.doc!
  76.  
  77. Perhaps it is of interest for you how the verbatim typesetting in
  78. progltx is done---the scheme is robuster than the one LaTeX uses, it
  79. works with tabs (are you working on a VAX or a PC?), but it's slower,
  80. too. In the last sections of the files you can have a look at the
  81. `great' internal design of the current LaTeX, too.
  82.  
  83.  
  84.  
  85. Well, I hope that you will enjoy the macros
  86.  
  87.             Greetings
  88.             Joachim Schrod
  89.  
  90.  
  91. current address:
  92.     Technical University of Darmstadt
  93.     Department of Computer Science
  94.     Joachim Schrod
  95.     Alexanderstr. 10
  96.  
  97.     D-6100 Darmstadt
  98.     FR Germany
  99.  
  100.     Email: xitijsch@ddathd21.bitnet
  101.  
  102.  
  103. ==============================================================================
  104.  
  105. The following files are in the distribution:
  106.  
  107. COPYING        copy conditions, i.e. the GNU General Public License
  108. README        this file you are reading
  109.  
  110. chbars.doc      The documented macro source (with MAKEPROG!)
  111. progltx.sty     Style files needed to print it.
  112. a4-9.sty
  113.  
  114. chbars.sty    the macro version of chbars.doc  
  115. chbars.tex    the macro version of chbars.doc (identical to chbars.tex)
  116. chbars-orig.tex Joachim Schrod's original macro version of chbars.doc  
  117. test1.tex    Test files for chbars.tex
  118. test2.tex
  119. test3.tex       Test file for some of the newer features added
  120. test4.ltx       LaTeX test file for chbars.sty (a.k.a chbars.tex)
  121.  
  122. a4-9.doc        a non-arbitrary A4 page layout style option
  123. a4-marg.chf     changefile for a4-9.doc, adaption to 1in driver margin
  124.  
  125. makeprog.perl   Perl version of MAKEPROG
  126. makeprog.lex    Lex  version of MAKEPROG
  127. --
  128.